/**
 *    Copyright 2009-2019 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.builder;

import java.util.HashMap;

/**
 * 参数表达式解析器
 * <p>
 * Inline parameter expression parser. Supported grammar (simplified):
 *
 * <pre>
 * inline-parameter = (propertyName | expression) oldJdbcType attributes
 * propertyName = /expression language's property navigation path/
 * expression = '(' /expression language's expression/ ')'
 * oldJdbcType = ':' /any valid jdbc type/
 * attributes = (',' attribute)*
 * attribute = name '=' value
 * </pre>
 *
 * @author Frank D. Martinez [mnesarco]
 */
public class ParameterExpression extends HashMap<String, String> {

    private static final long serialVersionUID = -2417552199605158680L;

    public ParameterExpression(String expression) {
        // 开始解析表达式
        parse(expression);
    }

    /**
     * 解析表达式
     *
     * @param expression 表达式
     */
    private void parse(String expression) {
        // 找到第一个非控制字符
        int p = skipWS(expression, 0);
        if (expression.charAt(p) == '(') {
            // 解析括号内的内容
            expression(expression, p + 1);
        } else {

            property(expression, p);
        }
    }

    /**
     * 解析表达式
     *
     * @param expression 表达式
     * @param left       起始位置
     */
    private void expression(String expression, int left) {
        // 计算（）的次数
        int match = 1;
        // 结束位置
        int right = left + 1;
        while (match > 0) {
            // 当目前找到的括号完全闭合时，退出循环
            if (expression.charAt(right) == ')') {
                // 如果找到） 表示闭合一个括号
                match--;
            } else if (expression.charAt(right) == '(') {
                // 如果找到一个( 表示新开一个
                match++;
            }
            // 指针右移
            right++;
        }
        // 将括号内的内容保存起来
        put("expression", expression.substring(left, right - 1));
        jdbcTypeOpt(expression, right);
    }

    /**
     * 解析表达式中的参数定义
     *
     * @param expression 表达式
     * @param left       起始位置
     */
    private void property(String expression, int left) {
        if (left < expression.length()) {
            int right = skipUntil(expression, left, ",:");
            put("property", trimmedStr(expression, left, right));
            // 处理jdbc类型和参数定义
            jdbcTypeOpt(expression, right);
        }
    }

    /**
     * 寻找指定表达式内的第一个非控制字符所在的位置
     *
     * @param expression 表达式
     * @param p          起始位置
     */
    private int skipWS(String expression, int p) {
        for (int i = p; i < expression.length(); i++) {
            if (expression.charAt(i) > 0x20) {
                return i;
            }
        }
        return expression.length();
    }

    /**
     * 截取字符串从指定位置到指定的字符之前
     *
     * @param expression 字符串
     * @param p          起始位置
     * @param endChars   不能包含的字符集合
     */
    private int skipUntil(String expression, int p, final String endChars) {
        for (int i = p; i < expression.length(); i++) {
            // 获取表达式中指定位置的参数
            char c = expression.charAt(i);
            if (endChars.indexOf(c) > -1) {
                // 命中结束标记,返回位置
                return i;
            }
        }
        return expression.length();
    }

    /**
     * 解析表达式中的jdbc类型和参数定义
     *
     * @param expression 表达式
     * @param p          起始位置
     */
    private void jdbcTypeOpt(String expression, int p) {
        // 获取第一个非控制字符的位置
        p = skipWS(expression, p);
        if (p < expression.length()) {
            // 表达式中包含非控制字符
            if (expression.charAt(p) == ':') {
                // 处理表达式的 :
                jdbcType(expression, p + 1);
            } else if (expression.charAt(p) == ',') {
                // 处理表达式的 ,
                option(expression, p + 1);
            } else {
                throw new BuilderException("Parsing error in {" + expression + "} in position " + p);
            }
        }
    }

    /**
     * 获取表达式中的jdbc类型
     *
     * @param expression 表达式
     * @param p          起始位置
     */
    private void jdbcType(String expression, int p) {
        // 获取第一个非控制字符
        int left = skipWS(expression, p);
        // 获取,号之前的内容
        int right = skipUntil(expression, left, ",");
        if (right > left) {
            // 保存jdbc类型
            put("jdbcType", trimmedStr(expression, left, right));
        } else {
            throw new BuilderException("Parsing error in {" + expression + "} in position " + p);
        }
        option(expression, right + 1);
    }

    /**
     * 解析指定表达式中的 key=value
     *
     * @param expression 表达式
     * @param p          起始位置
     */
    private void option(String expression, int p) {
        // 处理前置控制字符
        int left = skipWS(expression, p);
        if (left < expression.length()) {
            // 获取 = 号之前的内容的结束位置
            int right = skipUntil(expression, left, "=");
            // 获取名称
            String name = trimmedStr(expression, left, right);
            // 获取值
            left = right + 1;
            right = skipUntil(expression, left, ",");
            String value = trimmedStr(expression, left, right);
            // 放值
            put(name, value);
            // 继续解析
            option(expression, right + 1);
        }
    }

    /**
     * 去除指定字符串前后的控制字符
     *
     * @param str   字符串
     * @param start 起始位置
     * @param end   结束位置
     * @return 去除前后的控制字符的字符串
     */
    private String trimmedStr(String str, int start, int end) {
        // 去除前置跳过控制字符
        while (str.charAt(start) <= 0x20) {
            start++;
        }
        // 去除后置跳过控制字符
        while (str.charAt(end - 1) <= 0x20) {
            end--;
        }
        // 获取完整的数据
        return start >= end ? "" : str.substring(start, end);
    }

}
